Skip to main content
POST
/
auth
/
verify
Verify the user token
curl --request POST \
  --url https://your_a2_service/auth/verify \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>"
}
'
{ "budget": 123, "campaign_count": 1, "creative_count": 1, "credit": 123, "email": "jsmith@example.com", "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "is_active": true, "is_superuser": true, "is_verified": true, "permissions": {}, "placement_count": 1, "preferences": { "etc": {}, "notification_methods": {}, "notification_methods_data": {}, "notifications": {} }, "role": "advertiser", "name": "<string>" }

Body

application/json
​
token
string
required

Response

Successful Response

Represents a read command for a user.

​
budget
number
required

The total budget currently available to the user.

​
campaign_count
integer
required

The number of campaigns owned by the user.

Required range: x >= 0
​
creative_count
integer
required

The number of creatives owned by the user.

Required range: x >= 0
​
credit
number
required

The total credit currently available to the user.

​
email
string<email>
required

The email of the user.

​
id
string<uuid>
required

The id of the user.

​
is_active
boolean
required

Is the user active.

​
is_superuser
boolean
required

Is the user admin.

​
is_verified
boolean
required

Is the user email is verified.

​
permissions
Permissions · object
required

The permissions information of the user.

Examples:
{}

{
  "admin": [],
  "advertiser": ["permission"],
  "analytic": ["campaign"],
  "audience": [],
  "audience_attribute": ["r"],
  "audience_segment": ["r", "w"],
  "campaign": ["r", "w"],
  "creative": ["r", "w"],
  "placement": ["r"],
  "retailer": []
}

{
  "admin": ["list_advertisers", "budget"],
  "advertiser": [],
  "analytic": ["placement"],
  "audience": ["r"],
  "audience_attribute": ["r", "w"],
  "audience_segment": ["r", "w"],
  "campaign": ["r"],
  "creative": ["r", "w"],
  "placement": ["r", "w"],
  "retailer": ["approval", "permission"]
}
​
placement_count
integer
required

The number of placements owned by the user.

Required range: x >= 0
​
preferences
UserPreferences · object
required

Represents a user preferences.

​
role
enum<string>
required

User role enum.

Available options:
advertiser,
retailer,
admin
​
name
string | null

The name of the user.